Namespace containing all classes that make up the properties interface for the Window base class
*/
namespace WindowProperties
{
/*!
\brief
Property to access minimum window size.
This property offers access to the minimum size setting for the window, using screen relative metrics.
\par Usage:
- Name: RelativeMinSize
- Format: "w:[float] h:[float]".
\par Where:
- w:[float] specifies the minimum width as a floating point number.
- h:[float] specifies the minimum height as a floating point number.
*/
class RelativeMinSize : public Property
{
public:
RelativeMinSize() : Property(
"RelativeMinSize",
"Property to get/set the minimum size for the Window. Value is \"w:[float] h:[float]\" using relative metrics (this setting is relative to the display size).",
This property offers access to the maximum size setting for the window, using screen relative metrics.
\par Usage:
- Name: RelativeMaxSize
- Format: "w:[float] h:[float]".
\par Where:
- w:[float] specifies the maximum width as a floating point number.
- h:[float] specifies the maximum height as a floating point number.
*/
class RelativeMaxSize : public Property
{
public:
RelativeMaxSize() : Property(
"RelativeMaxSize",
"Property to get/set the maximum size for the Window. Value is \"w:[float] h:[float]\" using relative metrics (this setting is relative to the display size).",
This property offers access to the current mouse cursor image for the window.
\par Usage:
- Name: MouseCursorImage
- Format: "set:[text] image:[text]".
\par Where:
- set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
- image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
*/
class MouseCursorImage : public Property
{
public:
MouseCursorImage() : Property(
"MouseCursorImage",
"Property to get/set the mouse cursor image for the Window. Value should be \"set:<imageset name> image:<image name>\".",
- l:[float] specifies the position of the left edge of the area as a floating point number, using the active metrics system for the Window.
- t:[float] specifies the position of the top edge of the area as a floating point number, using the active metrics system for the Window.
- r:[float] specifies the position of the right edge of the area as a floating point number, using the active metrics system for the Window.
- b:[float] specifies the position of the bottom edge of the area as a floating point number, using the active metrics system for the Window.
*/
class Rect : public Property
{
public:
Rect() : Property(
"Rect",
"Property to get/set the area rectangle of the Window. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom) using the active metrics system.",
- l:[float] specifies the position of the left edge of the area as a floating point number, using the relative metrics system.
- t:[float] specifies the position of the top edge of the area as a floating point number, using the relative metrics system.
- r:[float] specifies the position of the right edge of the area as a floating point number, using the relative metrics system.
- b:[float] specifies the position of the bottom edge of the area as a floating point number, using the relative metrics system.
*/
class RelativeRect : public Property
{
public:
RelativeRect() : Property(
"RelativeRect",
"Property to get/set the area rectangle of the Window. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom) using relative metrics.",
- l:[float] specifies the position of the left edge of the area as a floating point number, using the absolute metrics system.
- t:[float] specifies the position of the top edge of the area as a floating point number, using the absolute metrics system.
- r:[float] specifies the position of the right edge of the area as a floating point number, using the absolute metrics system.
- b:[float] specifies the position of the bottom edge of the area as a floating point number, using the absolute metrics system.
*/
class AbsoluteRect : public Property
{
public:
AbsoluteRect() : Property(
"AbsoluteRect",
"Property to get/set the area rectangle of the Window. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom) using absolute metrics.",